feat(api): add register static method #136 #132 #137

sun-mota · 2024-10-23T19:57:33Z

Alaska Airlines Pull Request

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Resolves: #132 #136 #138

Summary:

Update dependency versions
AuroFlight.register is to easily register the element without extra importing
import "@aurodesignsystem/auro-flight" will still register this element to
import { AuroFlight } from '../src/auro-flight wont register this element until AuroFlight.register gets called

Type of change:

Please delete options that are not relevant.

New capability
Revision of an existing capability
Infrastructure change (automation, etc.)
Other (please elaborate)

Checklist:

My update follows the CONTRIBUTING guidelines of this project
I have performed a self-review of my own update

By submitting this Pull Request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Pull Requests will be evaluated by their quality of update and whether it is consistent with the goals and values of this project. Any submission is to be considered a conversation between the submitter and the maintainers of this project and may require changes to your submission.

Thank you for your submission!

-- Auro Design System Team

Summary by Sourcery

Add a static method 'AuroFlight.register' to enable custom registration of the 'auro-flight' element, update Rollup build configuration for demo examples, and enhance documentation with usage guidelines and examples for the new registration method.

New Features:

Introduce a static method 'AuroFlight.register' to allow custom registration of the 'auro-flight' element with a unique name.

Enhancements:

Update Rollup configuration to include a new build target for demo examples, outputting to 'index.min.js'.

Documentation:

Add documentation on recommended use and version control for the 'AuroFlight.register' method, including examples of custom element registration.

- Update dependency versions - `AuroFlight.register` is to easily register the element without extra importing - `import "@aurodesignsystem/auro-flight"` will still register this element to <auro-flight> - `import { AuroFlight } from '../src/auro-flight` wont register this element until `AuroFlight.register` gets called

sourcery-ai · 2024-10-23T19:57:37Z

Reviewer's Guide by Sourcery

This PR introduces a new static register method to the AuroFlight component, allowing for custom element registration with unique names to prevent version conflicts. The implementation includes documentation updates, code examples, and build configuration changes.

Class diagram for AuroFlight with new register method

classDiagram
    class AuroFlight {
        +static register(name="auro-flight")
        +firstUpdated()
    }
    note for AuroFlight "The register method allows custom element registration with a unique name."

File-Level Changes

Change	Details	Files
Added static register method for custom element registration	Implemented static register method with optional name parameter defaulting to 'auro-flight' Removed default element registration code Added utility method call to handle component registration	`src/auro-flight.js`
Updated documentation with custom element registration examples	Added new section explaining component versioning and registration Included code examples showing custom element registration Added example implementation with custom element name	`demo/index.md` `docs/partials/index.md`
Modified build configuration and dependencies	Added new rollup configuration for index examples Updated script references in demo pages Removed unnecessary icon dependency	`rollup.config.mjs` `demo/index.html` `demo/api.html`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time. You can also use
this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @sun-mota - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider keeping the default element registration for while adding the new register capability to maintain backward compatibility. Completely removing it could break existing implementations.

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟢 Security: all looks good
🟢 Testing: all looks good
🟡 Complexity: 1 issue found
🟡 Documentation: 1 issue found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

rollup.config.mjs

demo/index.md

demo/index.min.js

…xample

jason-capsule42

Demo API page needs to import the same way as the index page.

jason-capsule42

This needs to release first: AlaskaAirlines/auro-flightline#77

Then do a dependency update on this PR.

package.json

demo/api.html

demo/api.js

demo/api.md

demo/index.html

docs/api.md

…method #138 The new wca script to generate temporary `js` files that defines element in the file so that `wca` wont skip the analyzation The temporary files will get removed after alayzation

…/wca` for wca to analyze

scripts/wca/auro-flight.js

blackfalcon · 2024-11-05T23:49:49Z

🎉 This PR is included in version 3.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

sun-mota requested a review from a team as a code owner October 23, 2024 19:57

sun-mota self-assigned this Oct 23, 2024

sun-mota linked an issue Oct 23, 2024 that may be closed by this pull request

Update component registration logic #136

Closed

sourcery-ai bot reviewed Oct 23, 2024

View reviewed changes

docs: use module path instead of relative src path in customization e…

5b43107

…xample

jason-capsule42 requested changes Oct 23, 2024

View reviewed changes

refactor: add demo/api.js into bundler

d2bc828

sun-mota requested a review from jason-capsule42 October 23, 2024 23:40

jason-capsule42 requested changes Oct 23, 2024

View reviewed changes

sun-mota requested a review from jason-capsule42 October 24, 2024 02:43

perf: update dependency

74d9f6b

jordanjones243 requested changes Oct 25, 2024

View reviewed changes

package.json Show resolved Hide resolved

demo/api.html Outdated Show resolved Hide resolved

demo/api.js Outdated Show resolved Hide resolved

demo/api.md Show resolved Hide resolved

demo/index.html Outdated Show resolved Hide resolved

docs/api.md Show resolved Hide resolved

sun-mota added 2 commits October 25, 2024 10:57

perf: remove unused CDN import in demo/api.html

6a6696d

perf: remove unused CDN inport in demo/index.html

d2d75e0

jordanjones243 mentioned this pull request Oct 25, 2024

BREAKING CHANGE(api): add register static method AlaskaAirlines/auro-icon#145

Merged

6 tasks

test: remove unnecessary console log in test #132

748de85

sun-mota force-pushed the sunMota/easyRegistry/136 branch from 52902ea to 748de85 Compare November 1, 2024 17:25

sun-mota changed the title ~~feat(api): add register static method #82~~ feat(api): add register static method #136 #132 Nov 1, 2024

sun-mota linked an issue Nov 1, 2024 that may be closed by this pull request

Clean up comments in test file #132

Closed

sun-mota added 7 commits November 4, 2024 16:02

docs: add custom script to support wca to work with new registration …

9558b2a

…method #138 The new wca script to generate temporary `js` files that defines element in the file so that `wca` wont skip the analyzation The temporary files will get removed after alayzation

perf: reduce complexity in script

96014fe

perf: edge case handling in templated code generator

2ada633

docs: a separate script build:api:prepare to generate file in `docs…

b64782a

…/wca` for wca to analyze

docs: clean up scripts and wca comp's location

8a5f398

docs: remove build:api:prepare from package.json

8fc9ff6

docs: update demo/api.md #138

2754de4

sun-mota linked an issue Nov 5, 2024 that may be closed by this pull request

api md does not get generated with new registration method #138

Closed

perf: add noResolver to rollup config

13a9c36

sun-mota requested a review from jordanjones243 November 5, 2024 16:50

jason-capsule42 reviewed Nov 5, 2024

View reviewed changes

scripts/wca/auro-flight.js Outdated Show resolved Hide resolved

jason-capsule42 reviewed Nov 5, 2024

View reviewed changes

scripts/wca/auro-flight.js Outdated Show resolved Hide resolved

docs: remove @(.*) on wca script

28a2bcc

sun-mota requested a review from jason-capsule42 November 5, 2024 21:04

jason-capsule42 approved these changes Nov 5, 2024

View reviewed changes

jordanjones243 approved these changes Nov 5, 2024

View reviewed changes

sun-mota merged commit 0d0ac1b into main Nov 5, 2024
6 checks passed

sun-mota deleted the sunMota/easyRegistry/136 branch November 5, 2024 23:47

blackfalcon added the released Completed work has been released label Nov 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(api): add register static method #136 #132 #137

feat(api): add register static method #136 #132 #137

sun-mota commented Oct 23, 2024 •

edited

Loading

sourcery-ai bot commented Oct 23, 2024 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

jason-capsule42 left a comment

jason-capsule42 left a comment

blackfalcon commented Nov 5, 2024

feat(api): add register static method #136 #132 #137

feat(api): add register static method #136 #132 #137

Conversation

sun-mota commented Oct 23, 2024 • edited Loading

Alaska Airlines Pull Request

Summary:

Type of change:

Checklist:

Summary by Sourcery

sourcery-ai bot commented Oct 23, 2024 • edited Loading

Reviewer's Guide by Sourcery

Class diagram for AuroFlight with new register method

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

Choose a reason for hiding this comment

jason-capsule42 left a comment

Choose a reason for hiding this comment

jason-capsule42 left a comment

Choose a reason for hiding this comment

blackfalcon commented Nov 5, 2024

sun-mota commented Oct 23, 2024 •

edited

Loading

sourcery-ai bot commented Oct 23, 2024 •

edited

Loading